home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / whati~gz.zoo / mkwhatis.8z / mkwhatis
Text File  |  1992-09-13  |  1KB  |  53 lines
  1.  
  2. NAME
  3.     mkwhatis - tool for making entries in whatis(1) databases
  4.  
  5. SYNOPSIS
  6.     mkwhatis manpage...
  7.  
  8. DESCRIPTION
  9.     mkwhatis  reads  the input files (which should be manpage source
  10.     files)  and  extracts  information  for  the  database  used  by
  11.     whatis(1).   It is not perfect, but should help substantially in
  12.     this otherwise tedious task.
  13.  
  14. NOTES
  15.     For the format of the whatis database, see whatis(5).
  16.  
  17.     whatis assumes manpages that look like this:
  18.     
  19.         .TH FOO 1X        <-- section, subsection
  20.         .SH NAME
  21.         foo \- blah blah blah    <-- name, desc
  22.         .SH DESCIPTION
  23.         .
  24.         .
  25.         .
  26.         .SH "SEE ALSO"
  27.         bar(1), foobar(5)    <-- cross references
  28.         .SH SOMETHING  (or eof)
  29.     
  30.     or
  31.     
  32.         .TH FOO 1 LOCAL
  33.         .
  34.         .
  35.         .
  36.     
  37.     It does not handle sourced files (aliases), ie:
  38.     
  39.         .so man1/foo.1
  40.     
  41.     At a minimum, you will have to add keywords yourself.
  42.  
  43. SEE ALSO
  44.     man(1), whatis(1), whatisin(1), apropos(1), whatis(5)
  45.  
  46. AUTHOR
  47.     Bill Rosenkranz
  48.     rosenkra@convex.com
  49.  
  50. VERSION
  51.     mkwhatis 2.0.1 92/9/12 rosenkra
  52.  
  53.